Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add presentation section to docsite #106

Merged
merged 2 commits into from
Oct 6, 2024
Merged

Add presentation section to docsite #106

merged 2 commits into from
Oct 6, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Oct 3, 2024

Description

This PR adds a presentation section to the docsite for viewing posters and similar materials. I've added the existing poster there as well. I needed to make adjustments to how the poster publishes in order to make this happen (Quarto does not allow for external directory output on it's own, so I used mv here to accomplish this through poe).

I've tested this locally as best as I could but we may run into issues depending on what happens during GitHub Actions or GitHub Pages processing.

Closes #98

What kind of change(s) are included?

  • Documentation (changes docs or other related content)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • These changes pass all pre-commit checks.
  • I have added comments to my code to help provide understanding
  • I have added a test which covers the code changes found within this PR
  • I have deleted all non-relevant text in this pull request template.

@d33bs d33bs requested a review from jenna-tomkinson October 3, 2024 14:44
@d33bs d33bs marked this pull request as ready for review October 3, 2024 15:01
jenna-tomkinson
jenna-tomkinson approved these changes Oct 4, 2024
View reviewed changes
Copy link
Member

@jenna-tomkinson jenna-tomkinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! For these types of website/docs updates, is there a way for me to pull it up to test if this is working for next time?

@d33bs d33bs mentioned this pull request Oct 6, 2024
Closed
@d33bs
Copy link
Member Author

d33bs commented Oct 6, 2024

Thanks @jenna-tomkinson for the review! Will merge this in shortly.

For these types of website/docs updates, is there a way for me to pull it up to test if this is working for next time?

The docs changes can be previewed with:

# with sphinx-build (quicker)
poetry run sphinx-build docs/src docs/build
# open `docs/build/index.html` after a build

# with sphinx-multiversion (more accurate to what our docs are)
poetry run sphinx-multiversion docs/src docs/build
# open `docs/build/v0.0.11/index.html` (or related version) after a build

It's tricky because the local version of these docs won't work exactly as we see in the docsite because of the linking and build process. We also can't use certain HTTP functionality when we don't have a web host (local files through the browser act differently than they do when served by a web host like GitHub Pages). There are some additional configurations like the changes in this PR which move files around to help prepare for web hosting through GitHub pages (see .github/workflows/publish-docs.yml for more of an outline on what happens). These are some customizations to help make the project more cohesive or add functionality I thought might help share the work with others. We should update this through #107 for a better understanding in the contribution guide too!

@d33bs d33bs merged commit 6fe30af into WayScience:main Oct 6, 2024
9 checks passed
@d33bs d33bs deleted the poster-display-for-docs branch October 6, 2024 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jenna-tomkinson jenna-tomkinson jenna-tomkinson approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make presentation content available through docsite
2 participants
@d33bs @jenna-tomkinson